<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: ChiVoxSDK</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Class: ChiVoxSDK</h1>

    




<section>

<header>
    
        <h2><span class="attribs"><span class="type-signature"></span></span>
            <span class="ancestors"><a href="module-ChiVoxSDK.html">ChiVoxSDK</a>~</span>ChiVoxSDK<span class="signature">(options)</span><span class="type-signature"></span></h2>
        
            <div class="class-description">ChiVoxSDK类。<br/><br/>

根据当前环境和配置，初始化并管理一个录音机，播放器。<br/>
支持2种模式：
  1. HTML5（默认，浏览器不支持的情况下会自动切换FLASH模式）。<br/>
  2. FLASH模式。<br/>
支持边录边评，支持语音speex压缩。</div>
        
    
</header>

<article>
    <div class="container-overview">
    
        

    
    <h2>Constructor</h2>
    

    
    <h4 class="name" id="ChiVoxSDK"><span class="type-signature"></span>new ChiVoxSDK<span class="signature">(options)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    创建一个ChiVoxSDK实例。
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">初始化参数。格式参见：<a href="global.html#Default_ChiVoxSDK_Options">Default_ChiVoxSDK_Options</a></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="chivoxsdk.js.html">chivoxsdk.js</a>, <a href="chivoxsdk.js.html#line109">line 109</a>
    </li></ul></dd>
    

    

    

    
</dl>


















    
    </div>

    

    

    

    

    

    

    
        <h3 class="subsection-title">Members</h3>

        
            
<h4 class="name" id=".CnSentScore"><span class="type-signature">(static) </span>CnSentScore<span class="type-signature"></span></h4>




<div class="description">
    ChiVoxSDK的中文句子评分结果类。
</div>







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="chivoxsdk.js.html">chivoxsdk.js</a>, <a href="chivoxsdk.js.html#line132">line 132</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".CnWordScore"><span class="type-signature">(static) </span>CnWordScore<span class="type-signature"></span></h4>




<div class="description">
    ChiVoxSDK的中文单词评分结果类。
</div>







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="chivoxsdk.js.html">chivoxsdk.js</a>, <a href="chivoxsdk.js.html#line130">line 130</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".DIALOG"><span class="type-signature">(static) </span>DIALOG<span class="type-signature"></span></h4>




<div class="description">
    ChiVoxSDK的状态对话框类。
</div>







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="chivoxsdk.js.html">chivoxsdk.js</a>, <a href="chivoxsdk.js.html#line136">line 136</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".EnScoreMap"><span class="type-signature">(static) </span>EnScoreMap<span class="type-signature"></span></h4>




<div class="description">
    ChiVoxSDK的英文评分结果里音素与国际音标的MAP类。
</div>







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="chivoxsdk.js.html">chivoxsdk.js</a>, <a href="chivoxsdk.js.html#line122">line 122</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".EnSentRec"><span class="type-signature">(static) </span>EnSentRec<span class="type-signature"></span></h4>




<div class="description">
    ChiVoxSDK的英文有限分支评分结果类。
</div>







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="chivoxsdk.js.html">chivoxsdk.js</a>, <a href="chivoxsdk.js.html#line128">line 128</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".EnSentScore"><span class="type-signature">(static) </span>EnSentScore<span class="type-signature"></span></h4>




<div class="description">
    ChiVoxSDK的英文句子评分结果类。
</div>







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="chivoxsdk.js.html">chivoxsdk.js</a>, <a href="chivoxsdk.js.html#line126">line 126</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".EnWordScore"><span class="type-signature">(static) </span>EnWordScore<span class="type-signature"></span></h4>




<div class="description">
    ChiVoxSDK的英文单词评分结果类。
</div>







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="chivoxsdk.js.html">chivoxsdk.js</a>, <a href="chivoxsdk.js.html#line124">line 124</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".MODE"><span class="type-signature">(static) </span>MODE<span class="type-signature"></span></h4>




<div class="description">
    ChiVoxSDK模块提供的模式枚举对象。包含HTML5，FLASH两种。
</div>







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="chivoxsdk.js.html">chivoxsdk.js</a>, <a href="chivoxsdk.js.html#line116">line 116</a>
    </li></ul></dd>
    

    

    

    
</dl>





    <h5>Example</h5>
    
    <pre class="prettyprint"><code>//使用模式FLASH：
var mode = ChiVoxSDK.MODE.FLASH;</code></pre>



        
            
<h4 class="name" id=".Paragraph"><span class="type-signature">(static) </span>Paragraph<span class="type-signature"></span></h4>




<div class="description">
    ChiVoxSDK的简单段落评分评分结果类。
</div>







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="chivoxsdk.js.html">chivoxsdk.js</a>, <a href="chivoxsdk.js.html#line134">line 134</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".StatusCode"><span class="type-signature">(static) </span>StatusCode<span class="type-signature"></span></h4>




<div class="description">
    ChiVoxSDK的状态码类。
</div>







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="chivoxsdk.js.html">chivoxsdk.js</a>, <a href="chivoxsdk.js.html#line120">line 120</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".VERSION"><span class="type-signature">(static) </span>VERSION<span class="type-signature"></span></h4>




<div class="description">
    ChiVoxSDK当前版本
</div>







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="chivoxsdk.js.html">chivoxsdk.js</a>, <a href="chivoxsdk.js.html#line118">line 118</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
    

    
        <h3 class="subsection-title">Methods</h3>

        
            

    

    
    <h4 class="name" id=".createPlayer"><span class="type-signature">(static) </span>createPlayer<span class="signature">(options)</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

    



<div class="description">
    创建一个播放器。
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">创建播放器所需要的参数。</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="chivoxsdk.js.html">chivoxsdk.js</a>, <a href="chivoxsdk.js.html#line228">line 228</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    - Html5Player或FlashPlayer的实例。
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id=".createRecorder"><span class="type-signature">(static) </span>createRecorder<span class="signature">(options)</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

    



<div class="description">
    创建一个录音机。
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">创建录音机所需要的参数。</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="chivoxsdk.js.html">chivoxsdk.js</a>, <a href="chivoxsdk.js.html#line238">line 238</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    - Html5Recorder或FlashRecorder的实例。
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id=".detect_flash_plugin"><span class="type-signature">(static) </span>detect_flash_plugin<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
    

    



<div class="description">
    检测当前浏览器是否能够正常使用Flash插件。
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="chivoxsdk.js.html">chivoxsdk.js</a>, <a href="chivoxsdk.js.html#line217">line 217</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    - 是否能够正常使用Flash插件。
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id=".mode"><span class="type-signature">(static) </span>mode<span class="signature">(mode)</span><span class="type-signature"> &rarr; {string}</span></h4>
    

    



<div class="description">
    ChiVoxSDK当前模式的人性化输出。
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>mode</code></td>
            

            <td class="type">
            
                
<span class="param-type">enum</span>


            
            </td>

            

            

            <td class="description last">ChiVoxSDK.MODE.HTML5 或 ChiVoxSDK.MODE.FLASH的值。</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="chivoxsdk.js.html">chivoxsdk.js</a>, <a href="chivoxsdk.js.html#line144">line 144</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    - "HTML5" | "FLASH" | "UNKNOWN"。
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="bindPlayerEvent"><span class="type-signature"></span>bindPlayerEvent<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    为SDK实例绑定播放事件。
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="chivoxsdk.js.html">chivoxsdk.js</a>, <a href="chivoxsdk.js.html#line243">line 243</a>
    </li></ul></dd>
    

    

    

    
</dl>


















        
            

    

    
    <h4 class="name" id="bindRecorderEvent"><span class="type-signature"></span>bindRecorderEvent<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    为SDK实例绑定录音事件。
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="chivoxsdk.js.html">chivoxsdk.js</a>, <a href="chivoxsdk.js.html#line293">line 293</a>
    </li></ul></dd>
    

    

    

    
</dl>


















        
            

    

    
    <h4 class="name" id="bindReplayEvent"><span class="type-signature"></span>bindReplayEvent<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    为SDK实例绑定录音回放事件。
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="chivoxsdk.js.html">chivoxsdk.js</a>, <a href="chivoxsdk.js.html#line360">line 360</a>
    </li></ul></dd>
    

    

    

    
</dl>


















        
            

    

    
    <h4 class="name" id="resetStatus"><span class="type-signature"></span>resetStatus<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    SDK实例重置当前状态。
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="chivoxsdk.js.html">chivoxsdk.js</a>, <a href="chivoxsdk.js.html#line400">line 400</a>
    </li></ul></dd>
    

    

    

    
</dl>


















        
            

    

    
    <h4 class="name" id="setData"><span class="type-signature"></span>setData<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    SDK实例更新或设置data参数。 格式参见：<a href="global.html#Default_ChiVoxSDK_Options">Default_ChiVoxSDK_Options</a>
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="chivoxsdk.js.html">chivoxsdk.js</a>, <a href="chivoxsdk.js.html#line414">line 414</a>
    </li></ul></dd>
    

    

    

    
</dl>


















        
    

    

    
</article>

</section>




</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-ChiVoxSDK.html">ChiVoxSDK</a></li><li><a href="module-ChiVoxSDK_flash.html">ChiVoxSDK/flash</a></li><li><a href="module-ChiVoxSDK_html5.html">ChiVoxSDK/html5</a></li><li><a href="module-ChiVoxSDK_lib.html">ChiVoxSDK/lib</a></li><li><a href="module-ChiVoxSDK_Paragraph.html">ChiVoxSDK/Paragraph</a></li><li><a href="module-ChiVoxSDK_score.html">ChiVoxSDK/score</a></li></ul><h3>Classes</h3><ul><li><a href="module-ChiVoxSDK_flash.FlashPlayer.html">FlashPlayer</a></li><li><a href="module-ChiVoxSDK_flash.FlashRecorder.html">FlashRecorder</a></li><li><a href="module-ChiVoxSDK_html5.Html5Player.html">Html5Player</a></li><li><a href="module-ChiVoxSDK_html5.Html5Recorder.html">Html5Recorder</a></li><li><a href="module-ChiVoxSDK_html5-VolumeBar.html">VolumeBar</a></li><li><a href="module-ChiVoxSDK_lib-EnScoreMap.html">EnScoreMap</a></li><li><a href="module-ChiVoxSDK_lib-StatusCode.html">StatusCode</a></li><li><a href="module-ChiVoxSDK_Paragraph-Paragraph.html">Paragraph</a></li><li><a href="module-ChiVoxSDK_score-Char.html">Char</a></li><li><a href="module-ChiVoxSDK_score-CnSentScore.html">CnSentScore</a></li><li><a href="module-ChiVoxSDK_score-CnWordScore.html">CnWordScore</a></li><li><a href="module-ChiVoxSDK_score-EnSentRec.html">EnSentRec</a></li><li><a href="module-ChiVoxSDK_score-EnSentScore.html">EnSentScore</a></li><li><a href="module-ChiVoxSDK_score-EnWordScore.html">EnWordScore</a></li><li><a href="module-ChiVoxSDK_score-Phone.html">Phone</a></li><li><a href="module-ChiVoxSDK_score-Word.html">Word</a></li><li><a href="module-ChiVoxSDK-ChiVoxSDK.html">ChiVoxSDK</a></li><li><a href="module-ChiVoxSDK-ControlPanel.html">ControlPanel</a></li><li><a href="module-ChiVoxSDK-Dialog.html">Dialog</a></li><li><a href="module-ChiVoxSDK-PlayerBuilder.html">PlayerBuilder</a></li><li><a href="module-ChiVoxSDK-ProgressBar.html">ProgressBar</a></li><li><a href="module-ChiVoxSDK-RecorderBuilder.html">RecorderBuilder</a></li></ul><h3>Namespaces</h3><ul><li><a href="public.html">public</a></li><li><a href="Utils.html">Utils</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Default_ChiVoxPlayer_Options">Default_ChiVoxPlayer_Options</a></li><li><a href="global.html#Default_ChiVoxRecorder_Options">Default_ChiVoxRecorder_Options</a></li><li><a href="global.html#Default_ChiVoxSDK_Options">Default_ChiVoxSDK_Options</a></li><li><a href="global.html#Default_Paragraph_Options">Default_Paragraph_Options</a></li><li><a href="global.html#get_sig">get_sig</a></li><li><a href="global.html#tts">tts</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Sep 21 2017 16:38:41 GMT+0800 (CST)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>